Skip to main content

Application Approved

This is the status of the application when it has been approved by a creditor.

Request Body​

The request body must be a JSON object with the following properties:

  • retailerId (string): The ID of the retailer that created the application.
  • status (string, enum): The status of the application. Must be "APPROVED".
  • creditorId (string, required): The ID of the creditor that booked the application.
  • applicationId (string, required): The ID of the application that was approved.
  • conditions (string): The conditions of the approved application.
  • firstPaymentDate (string): The first payment date of the application.
  • frequency (string): The frequency of the application.
  • interestRate (number): The interest rate of the application.
  • approvedPayment (object): The approved payment details of the application.
  • rateReduction (number): The rate reduction of the application.
  • termStretch (number): The term stretch of the application.
  • maxPayment (object): The maximum payment details of the application.

Example Request Body​

{
  "retailerId": "ebed869d-bdf4-4b0a-8442-5b8f23753247",
  "status": "APPROVED",
  "creditorId": "c8e4cd75-7f66-49dc-b44a-076eb409ea0b",
  "applicationId": "3aad1c88-a898-460f-b2c7-5f4145250489",
  "conditions": "some requested item",
  "firstPaymentDate": "2021-01-01",
  "frequency": "WEEKLY",
  "interestRate": 17.99,
  "approvedPayment": { "amount": 850, "currency": "CAD" },
  "rateReduction": 1.0,
  "termStretch": 6,
  "maxPayment": { "amount": 750, "currency": "CAD" }
}

Response​

We ask that all webhooks return 200 OK status codes to confirm receipt of the webhook. We ask that unless the server is down errors to be logged and still return a 200 OK status code. If the webhook does not return a 200 OK status code, we will retry the webhook up to 10 times with an exponential backoff.